Skip to content

Document Path predicate fully expanded argument format#4116

Merged
ryanjbaxter merged 1 commit intospring-cloud:mainfrom
CheHyeonYeong:docs/issue-3523-predicate-naming
Mar 27, 2026
Merged

Document Path predicate fully expanded argument format#4116
ryanjbaxter merged 1 commit intospring-cloud:mainfrom
CheHyeonYeong:docs/issue-3523-predicate-naming

Conversation

@CheHyeonYeong
Copy link
Copy Markdown
Contributor

Summary

Adds documentation for the Path route predicate factory's fully expanded argument format, clarifying the indexed key notation (patterns.0, patterns.1) used for list parameters.

Changes

  • Added "Fully Expanded Arguments" subsection to the Path predicate documentation
  • Included YAML example showing patterns.0, patterns.1 notation
  • Added JSON example for Actuator API usage
  • Explained that args map only accepts String key-value pairs and how list parameters are converted

Context

Users were confused about how to specify multiple path patterns when configuring routes programmatically or via the Actuator API, as the args map requires String values but the predicate expects a List<String> for patterns.

Closes #3523

Add documentation for using the Path predicate with fully expanded
arguments, including indexed key notation (patterns.0, patterns.1)
for list parameters. This clarifies the naming convention when
configuring routes via the Actuator API or programmatically.

Fixes spring-cloudgh-3523

Signed-off-by: CheHyeonYeong <gusdudco6@naver.com>
@CheHyeonYeong CheHyeonYeong force-pushed the docs/issue-3523-predicate-naming branch from 925c822 to 33c0239 Compare March 27, 2026 08:12
@ryanjbaxter ryanjbaxter merged commit 55d71f3 into spring-cloud:main Mar 27, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Better docs about naming convention in PredicateDefinition: Path receives pattern key and it works?

3 participants